home *** CD-ROM | disk | FTP | other *** search
/ NeXTSTEP 3.2 for Intel / NeXTSTEP 3.2 for Intel.iso / NextLibrary / Documentation / Sybase / DBLIB / Section2 / dbcanquery.nr < prev    next >
Encoding:
Text File  |  1993-04-22  |  1.4 KB  |  48 lines
  1. .Na "dbcanquery" 
  2. .Aa
  3. .Fu
  4. Cancel any rows pending from the most recently executed query.
  5. .Ih "result rows, canceling"
  6. .Sy
  7. .Sf "RETCODE dbcanquery(dbproc)"
  8. .Sp "DBPROCESS" "*dbproc"
  9. .Co
  10. .Bl
  11. This routine is an efficient way to throw away any unread rows that
  12. result from the most recently executed SQL query. Calling \f2dbcanquery()\f1
  13. is equivalent to calling \f2dbnextrow()\f1 until it returns NO_MORE_ROWS,
  14. but \f2dbcanquery()\f1 is faster because it allocates no memory and executes no
  15. bindings to user data.
  16. .Bl
  17. If you have set your own interrupt handler using
  18. .I "dbsetinterrupt()" ,
  19. you can't call
  20. .I "dbcanquery()"
  21. in your interrupt handler.
  22. This would cause output from \*S to
  23. \*L to become out of sync.
  24. If you want to ignore any unread rows from the current query, 
  25. the interrupt handler should set a flag that you can check before the
  26. next call to \f2dbnextrow()\fP.
  27. .Bl
  28. If you want to ignore all of the results from all of the commands in the
  29. current command batch, call \f2dbcancel()\fP instead.
  30. .Bz
  31. .Pa
  32. .Pi dbproc
  33. A pointer to the DBPROCESS structure that provides the connection
  34. for a particular front-end/\*S process.  It contains all the
  35. information that \*L uses to manage communications and data between the
  36. front end and \*S.
  37. .in -.375i
  38. .Re
  39. .br
  40. SUCCEED or FAIL.
  41. The most common reasons for failure are a dead DBPROCESS or a network error.
  42. .Sa
  43. dbcancel,
  44. dbnextrow,
  45. dbresults,
  46. dbsetinterrupt,
  47. dbsqlexec
  48.